TE Product Data API
Products Model Response
The "Get Products" (/products), "Get Products By Part Number List" (/products/partnumbers), and "Get Single Product" (/products/partnumber/{tcpn}) endpoints share a common response structure for returning the Products information. The Products element structure that is returned for each of these 3 endpoint responses is documented below.
All data, images, text or other information or contentment provided through the API (TE Connectivity Data), including data related to import and export compliance, are subject to the Terms and Conditions and are provided “AS IS,” “AS AVAILABLE,” and may change without notice. TE makes no representation or warranty as to the completeness or accuracy of the data provided, and TE disclaims all liability relating to the use or reliance of TE Connectivity Data for purposes under this Agreement.
| Property | Description |
|---|---|
| tcpn | TE Corporate Part Number. This is also known as TE Internal Part Number. It is a unique part number among all of TE's part numbers and is sometimes only used for internal purposes. |
| endNodeCategoryId | A unique numeric value identifying the category/Product Line. |
| primaryCategoryTree | The complete category hierarchy for the product. |
| alternateCategoryTrees | If the product is cross listed in different hierarchies, this provides the alternate cross listed hierarchy tree. |
| partId | A unique numeric value assigned to the part number. On very rare occasions, the tcpn (TE Internal Part Number) can change; however, the partId will not change. Using the partId as your unique identifier can help on those rare occasions when the tcpn does change. |
| lastChangeDate | The date when a change was detected in the product's information. If the date is different than the date you have on file for the part number, you may want to reload the product's information. |
| primaryPartNumber | Also known as "marketing part number". This is the part number that TE presents to customers. This is the part number used in paper catalogs. It may or may not be the same as the tcpn. |
| tePartDetailUrl | The URL to the product's Product Detail Page on the TE.com website. |
| imageUrls.tePrimaryImageUrl | The URL for the primary image for the product. |
| imageUrls.teSourceImageUrl | The URL for the high resolution image for the product. |
| partAliases | If there are part numbers associated with the product other than the tcpn and primaryPartNumber, they are listed here. |
| partStatus | The product's current status code. |
| productCode | The Product Code. A Product Code identifies very similar products. |
| gplCode | The Global Product Line (GPL). A GPL identifies products that have similar and/or related characteristics across Product Codes. |
| gplDescription | The description of the Global Product Line (GPL). |
| htsCode | The Harmonized Commodity Code is a multipurpose international product nomenclature developed by the World Customs Organization (WCO). |
| eccnCode | In order to comply with international Export control regulations on certain products and technology (military or dual list) all materials are Classified with an Export Control Classification Number. |
| teOrderable | Indicates whether a product can be purchased directly on TE.com in the TE Store. |
| samplesAvailable | Indicates whether samples are available for this product. |
| euRohsCompliance | This is the EU RoHS Compliance status of the product. |
| euElvCompliance | This is the EU ELV Compliance status of the product. |
| leadFreeProcessDescription | Lead Free Process Description. This datum describes whether the product is suitable for Lead Free Soldering. |
| statementOfCompliance | This is a link to TE's Statement of Compliance. |
| partDescription | A brief description of the product. |
| attributes.attributeCategory | The features of the products are grouped into categories that you may choose to use or ignore. Categories will vary by Class/Product Line. Examples of categories are Product Type Features, Body Related Features, Industry Standards, and Packaging Related Features. |
| attributes.attributeTypes.value | Contains the value of the AttributeType (aka, Feature). |
| attributes.attributeTypes.id | A unique numeric value assigned to the Feature. This is provided in case you want to map TE AttributeType (Feature) Names to your own feature names. |
| attributes.attributeTypes.name | The AttributeType (Feature) name. |
| attributes.attributeTypes.uom | The AttributeType’s Unit Of Measure. If there is no Unit Of Measure associated with the AttributeType, then this property will be empty. |
| documents.documentType |
|
| documents.documentName | The name of the document; it is the document's unique identifier. A document can have numerous revisions and can be in different formats, but the docID will remain the same. |
| documents.documentRevision | The current document revision level. Typically, revisions start with A, B, C and so on. You should not need to care about the document revision unless you are storing the document on your website (not recommended). The provided direct access URL always links to the most recent version of the document. If you are storing the document on your website and the documentRevision changes, you will need to get a revised version of the document. Some documents will not have a documentRevision. Catalog Pages typically do not have revisions associated with them and the tag will be empty. |
| documents.documentTitle | The title of the document. |
| documents.documentSubType |
|
| documents.documentFileName | The complete name of the document file. |
| documents.documentFormat | The file format of the document. Most documents are in PDF format. |
| documents.documentSize | The size of the file in bytes. If you want to convert to KB or MB, you will need to do the conversion. |
| documents.documentLanguage | The language of the document. Only one language is provided, but some documents are in multiple languages and some documents, especially Product Drawings, can be useful even if they are not in the desired language. |
| documents.documentUrl | This is the direct access URL link to the document. It is highly recommended that you use this link to provide documents to your customers rather than storing documents on your website. This link will always provide the latest revision so it will always provide the most up-to-date information. |
| compatibleParts | Indicates other TE products that are compatible with the product. |
| replacementPart | List of part numbers for replacement products, which are recommended replacements for this product because it has either an Obsolete or Superceded part status. The replacement parts may not be form, fit and function replacements. Please use the replacement Product Drawing to validate use in your application. |
| milSpecs | Lists any Military Specifications that are certified to the product and any applicable Class information. |
| series | A group of products associated with each other and used in a specific type of application or environment. Examples: Dynamic 1000 Series, SOLARLOK, and FASTON 250 |